Added changes for rate limited sampler (azure-distro changes) #41976
+229
−22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rads-1996
requested review from
lzchen,
jeremydvoss,
hectorhdzg,
Karlie-777,
MSNev and
JacksonWeber
as code owners
github-actions
bot
added
Monitor - Distro
6 tasks
There was a problem hiding this comment.
Pull Request Overview
This PR extends the azure-distro to let users choose between a fixed‐percentage and a rate‐limited traces sampler via OTEL environment variables. Key changes include:
- Parsing
OTEL_TRACES_SAMPLER(sampler type) andOTEL_TRACES_SAMPLER_ARG(its argument) in_get_configurations. - Adding new constants (
RATE_LIMITED_SAMPLER,FIXED_PERCENTAGE_SAMPLER,SAMPLING_TRACES_PER_SECOND_ARG) and updatingazure/monitor/opentelemetry/_constants.py. - Updating
_configure.pyto selectRateLimitedSamplerwhensampling_traces_per_secondis set.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| .../tests/utils/test_configurations.py | Replaced SAMPLING_RATIO_ENV_VAR, added rate‐limited and fixed tests |
| .../azure/monitor/opentelemetry/_utils/configurations.py | Updated sampling defaults to branch on sampler type and argument |
| .../azure/monitor/opentelemetry/_constants.py | Introduced new constants for sampler types and trace‐per‐second arg |
| .../azure/monitor/opentelemetry/_configure.py | Added logic to wire up RateLimitedSampler when appropriate |
| ...-exporter/tests/trace/test_rate_limited_sampling.py | New comprehensive tests for RateLimitedSampler |
| ...-exporter/azure/.../_utils.py | Added _get_djb2_sample_score and rounding helper |
| ...-exporter/azure/.../_rate_limited_sampling.py | Implemented RateLimitedSamplingPercentage and RateLimitedSampler |
Comments suppressed due to low confidence (2)
sdk/monitor/azure-monitor-opentelemetry/tests/utils/test_configurations.py:178
- This test sets an invalid sampler arg (
"Half") but does not assert thatsampling_ratiofalls back to the default. Consider adding an assertion such asself.assertEqual(configurations["sampling_ratio"], 1.0)to verify fallback behavior.
@patch.dict(
sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/trace/_utils.py:330
- No tests cover
_round_down_to_nearestor edge cases of_get_djb2_sample_score. Adding unit tests would improve confidence in these utility functions.
def _get_djb2_sample_score(trace_id_hex: str) -> float:
Comment on lines
+127
to
+137
| if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None: | ||
| try: | ||
| if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0: | ||
| _logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.") | ||
| except ValueError: | ||
| pass | ||
| else: | ||
| _logger.error("OTEL_TRACES_SAMPLER_ARG is not set.") | ||
|
|
||
| # Check if rate-limited sampler is configured | ||
| if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER: |
There was a problem hiding this comment.
This block logs errors for missing or unset OTEL_TRACES_SAMPLER_ARG even when no custom sampler is requested. Consider only validating or logging when OTEL_TRACES_SAMPLER is set to a non-default value to avoid confusing error noise.
Suggested change
| if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None: | |
| try: | |
| if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0: | |
| _logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.") | |
| except ValueError: | |
| pass | |
| else: | |
| _logger.error("OTEL_TRACES_SAMPLER_ARG is not set.") | |
| # Check if rate-limited sampler is configured | |
| if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER: | |
| # Check if rate-limited sampler is configured | |
| if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER: | |
| if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None: | |
| try: | |
| if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0: | |
| _logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.") | |
| except ValueError: | |
| pass | |
| else: | |
| _logger.error("OTEL_TRACES_SAMPLER_ARG is not set.") |
Copilot uses AI. Check for mistakes.
sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_configure.py
Outdated
Show resolved
Hide resolved
sdk/monitor/azure-monitor-opentelemetry/tests/utils/test_configurations.py
Outdated
Show resolved
Hide resolved
sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_utils/configurations.py
Outdated
Show resolved
Hide resolved
rads-1996
force-pushed
the
rads-1996/rate-limited-sampler-distro
branch
from
d3c8014 to
de65c50
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding support for RateLimitedSampler, inspired by Java Application Insights sampler
https://github.com/microsoft/ApplicationInsights-Java/blob/main/agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/sampling/RateLimitedSamplingPercentage.java
This PR contains changes related to the configurations in the azure-distro only. The changes related to implementation of the rate limited sampler are in the azure-exporter in the PR - #41954.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines